From 91798e22e478239efa2d131c62d960918966ba79 Mon Sep 17 00:00:00 2001 From: robertl Date: Mon, 21 Jan 2008 05:24:19 +0000 Subject: [PATCH] Misc doc updates. --- internal_styles.c | 72 ++++++++++---------- style/s_and_t.style | 2 +- xmldoc/chapters/build.xml | 4 +- xmldoc/chapters/preface.xml | 4 +- xmldoc/chapters/use.xml | 29 +++++--- xmldoc/formats/csv.xml | 11 ++- xmldoc/formats/dg-100.xml | 10 +++ xmldoc/formats/gpx.xml | 2 +- xmldoc/formats/kml.xml | 9 ++- xmldoc/formats/options/garmin-resettime.xml | 1 + xmldoc/formats/options/garmin_gpi-alerts.xml | 1 + xmldoc/formats/options/garmin_gpi-unique.xml | 1 + xmldoc/formats/options/garmin_gpi-units.xml | 1 + xmldoc/formats/options/ozi-proximity.xml | 1 + 14 files changed, 92 insertions(+), 56 deletions(-) create mode 100644 xmldoc/formats/options/garmin-resettime.xml create mode 100644 xmldoc/formats/options/garmin_gpi-alerts.xml create mode 100644 xmldoc/formats/options/garmin_gpi-unique.xml create mode 100644 xmldoc/formats/options/garmin_gpi-units.xml create mode 100644 xmldoc/formats/options/ozi-proximity.xml diff --git a/internal_styles.c b/internal_styles.c index 78d4693b8..7c1a534ef 100644 --- a/internal_styles.c +++ b/internal_styles.c @@ -792,7 +792,7 @@ static char s_and_t[] = "# GC171C,44.70605,-85.62265,The Michigan Frog by RealDcoy & LRB,http://www.geocaching.com/seek/cache_details.aspx?ID=5916,Traditional Cache\n" "#\n" -"DESCRIPTION Microsoft Streets and Trips 2002-2006\n" +"DESCRIPTION Microsoft Streets and Trips 2002-2007\n" "EXTENSION txt\n" @@ -997,6 +997,40 @@ static char tomtom_itn[] = "IFIELD SHORTNAME, \"\", \"%s\"\n" "IFIELD CONSTANT, \"0\", \"%s\"\n" ; +static char xmap[] = +"# gpsbabel XCSV style file\n" +"#\n" +"# Format: DeLorme Xmap Conduit\n" +"# Author: Alex Mottram\n" +"# Date: 12/09/2002\n" +"#\n" +"# \n" +"# As defined in csv.c/xmap\n" +"#\n" + +"DESCRIPTION DeLorme XMap HH Native .WPT\n" +"EXTENSION wpt\n" + +"#\n" +"# FILE LAYOUT DEFINITIIONS:\n" +"#\n" +"FIELD_DELIMITER COMMASPACE\n" +"RECORD_DELIMITER NEWLINE\n" +"BADCHARS COMMA\n" + +"PROLOGUE BEGIN SYMBOL\n" +"EPILOGUE END\n" +"#\n" +"# INDIVIDUAL DATA FIELDS, IN ORDER OF APPEARANCE:\n" +"#\n" +"IFIELD LAT_HUMAN_READABLE, \"\", \"%08.5f\"\n" +"IFIELD LON_HUMAN_READABLE, \"\", \"%08.5f\"\n" +"IFIELD DESCRIPTION, \"\", \"%s\"\n" + +"OFIELD LAT_DECIMAL, \"\", \"%08.5f\"\n" +"OFIELD LON_DECIMAL, \"\", \"%08.5f\"\n" +"OFIELD DESCRIPTION, \"\", \"%s\"\n" +; static char xmap2006[] = "# gpsbabel XCSV style file\n" "#\n" @@ -1035,40 +1069,6 @@ static char xmap2006[] = -; -static char xmap[] = -"# gpsbabel XCSV style file\n" -"#\n" -"# Format: DeLorme Xmap Conduit\n" -"# Author: Alex Mottram\n" -"# Date: 12/09/2002\n" -"#\n" -"# \n" -"# As defined in csv.c/xmap\n" -"#\n" - -"DESCRIPTION DeLorme XMap HH Native .WPT\n" -"EXTENSION wpt\n" - -"#\n" -"# FILE LAYOUT DEFINITIIONS:\n" -"#\n" -"FIELD_DELIMITER COMMASPACE\n" -"RECORD_DELIMITER NEWLINE\n" -"BADCHARS COMMA\n" - -"PROLOGUE BEGIN SYMBOL\n" -"EPILOGUE END\n" -"#\n" -"# INDIVIDUAL DATA FIELDS, IN ORDER OF APPEARANCE:\n" -"#\n" -"IFIELD LAT_HUMAN_READABLE, \"\", \"%08.5f\"\n" -"IFIELD LON_HUMAN_READABLE, \"\", \"%08.5f\"\n" -"IFIELD DESCRIPTION, \"\", \"%s\"\n" - -"OFIELD LAT_DECIMAL, \"\", \"%08.5f\"\n" -"OFIELD LON_DECIMAL, \"\", \"%08.5f\"\n" -"OFIELD DESCRIPTION, \"\", \"%s\"\n" ; static char xmapwpt[] = "# gpsbabel XCSV style file\n" @@ -1102,7 +1102,7 @@ static char xmapwpt[] = "IFIELD IGNORE, \"\", \"%-.31s\"\n" "IFIELD DESCRIPTION, \"\", \"%-.78s\"\n" ; -style_vecs_t style_list[] = {{ "xmapwpt", xmapwpt } , { "xmap", xmap } , { "xmap2006", xmap2006 } , { "tomtom_itn", tomtom_itn } , { "tomtom_asc", tomtom_asc } , { "tabsep", tabsep } , { "sportsim", sportsim } , { "saplus", saplus } , { "s_and_t", s_and_t } , { "openoffice", openoffice } , { "nima", nima } , { "mxf", mxf } , { "mapconverter", mapconverter } , { "kwf2", kwf2 } , { "ktf2", ktf2 } , { "kompass_wp", kompass_wp } , { "kompass_tk", kompass_tk } , { "gpsman", gpsman } , { "gpsdrivetrack", gpsdrivetrack } , { "gpsdrive", gpsdrive } , { "geonet", geonet } , { "garmin_poi", garmin_poi } , { "garmin301", garmin301 } , { "fugawi", fugawi } , { "dna", dna } , { "custom", custom } , { "cup", cup } , { "csv", csv } , { "cambridge", cambridge } , { "arc", arc } , {0,0}}; +style_vecs_t style_list[] = {{ "xmapwpt", xmapwpt } , { "xmap2006", xmap2006 } , { "xmap", xmap } , { "tomtom_itn", tomtom_itn } , { "tomtom_asc", tomtom_asc } , { "tabsep", tabsep } , { "sportsim", sportsim } , { "saplus", saplus } , { "s_and_t", s_and_t } , { "openoffice", openoffice } , { "nima", nima } , { "mxf", mxf } , { "mapconverter", mapconverter } , { "kwf2", kwf2 } , { "ktf2", ktf2 } , { "kompass_wp", kompass_wp } , { "kompass_tk", kompass_tk } , { "gpsman", gpsman } , { "gpsdrivetrack", gpsdrivetrack } , { "gpsdrive", gpsdrive } , { "geonet", geonet } , { "garmin_poi", garmin_poi } , { "garmin301", garmin301 } , { "fugawi", fugawi } , { "dna", dna } , { "custom", custom } , { "cup", cup } , { "csv", csv } , { "cambridge", cambridge } , { "arc", arc } , {0,0}}; size_t nstyles = 30; #else /* CSVFMTS_ENABLED */ style_vecs_t style_list[] = {{0,0}}; diff --git a/style/s_and_t.style b/style/s_and_t.style index 364615485..dbc61c741 100644 --- a/style/s_and_t.style +++ b/style/s_and_t.style @@ -12,7 +12,7 @@ # GC171C,44.70605,-85.62265,The Michigan Frog by RealDcoy & LRB,http://www.geocaching.com/seek/cache_details.aspx?ID=5916,Traditional Cache # -DESCRIPTION Microsoft Streets and Trips 2002-2006 +DESCRIPTION Microsoft Streets and Trips 2002-2007 EXTENSION txt diff --git a/xmldoc/chapters/build.xml b/xmldoc/chapters/build.xml index 377f8f9dc..d19a228cd 100644 --- a/xmldoc/chapters/build.xml +++ b/xmldoc/chapters/build.xml @@ -37,7 +37,7 @@ need to 'apt-get install libusb-dev'. ./configure --help -lists all the supported options, but additionally we have: +lists all the supported options, but of interest we have: Excludes the shapefile support. @@ -53,7 +53,7 @@ lists all the supported options, but additionally we have: Activate debugging mode for gpsbabel-debug. - Specify that the doc should be created and installed in . + dir Specifies that the doc should be created and installed in dir. Disables use of libusb, even it's it's available. diff --git a/xmldoc/chapters/preface.xml b/xmldoc/chapters/preface.xml index 4ce0e356a..71c0293e5 100644 --- a/xmldoc/chapters/preface.xml +++ b/xmldoc/chapters/preface.xml @@ -18,13 +18,13 @@ won't read data created by your copy of Magellan Directroute. What you need is a program that converts data bewteen the two programs. -But GPSBabel actually does much more... +GPSBabel actually solves that problem for you and much more...
The Solution The original author of GPSBabel, Robert Lipe, needed to convert waypoints between a couple of formats, so he -whipped up a converter and based it on an extensible foundation so +whipped up a converter and designed it upon an extensible foundation so that it was easy to add new formats and made the program freely available. Many others have contributed to the program since then. Most file formats added so far have taken under 200 lines of reasonable ISO C so they can be stamped diff --git a/xmldoc/chapters/use.xml b/xmldoc/chapters/use.xml index 1a93a0287..29145d863 100644 --- a/xmldoc/chapters/use.xml +++ b/xmldoc/chapters/use.xml @@ -25,9 +25,14 @@ options you need to know to do those things: filename - Write output File + Write output file + + +Case matters. Notably (lowercase) sets the input file. (uppercase) sets the output file. + + The format parameters in the above list @@ -42,7 +47,11 @@ parentheses. Options are always processed in order from left to right. In practical terms, this means that things you want to read should appear -in the command before things you want to write. +in the command before things you want to write. This sometimes surprises +new users as adding options to turn on debugging at the end, for example, +doesn't work as the debugging is turned on after all the interesting work is +done. The reason for this strict ordering becomes more apparent once you +learn about mixing formats and filters. The filename parameters specify the @@ -50,15 +59,15 @@ name of a file to be read or written. To use - this program, just tell it what you're reading, where to read + GPSBabel in its simplest form, just tell it what you're reading, where to read it from, what you're writing, and what to write it to. For example: gpsbabel -i geo -f /tmp/geocaching.loc -o gpx -F /tmp/geocaching.gpx tells it to read the file /tmp/geocaching.loc in geocaching.com - format and create a new file /tmp/geocaching.gpx in GPX format. It's important to note that the names have nothign to do with the formats actually used. + format and create a new file /tmp/geocaching.gpx in GPX format. It's important to note that the names have nothing to do with the formats actually used. This command will read from a Magellan unit attached to the first serial port on a Linux system (device names will - vary on other OSes) and write them as a geocaching loc file. + vary on other OSes; typically COMx: on WIndows) and write them as a geocaching loc file. gpsbabel -i magellan -f /dev/ttyS0 -o geo -F mag.loc This second command does the same on Microsoft Windows. gpsbabel -i magellan -f com1 -o geo -F mag.loc @@ -68,12 +77,14 @@ name of a file to be read or written. long name. This is particularly useful if you're writing to a target format that isn't the lowest common denominator but the source data was written for the lowest common - denominator. I use this for writing data from geocaching.com - to my Magellan so my waypoints have "real" names instead of - the 'GC1234' ones that are optimized for NMEA-only receivers. - A geocacher with a Magellan receiver may thus find commands + denominator. This is useful for writing data from geocaching.com + to a GPS so my waypoints have "real" names instead of + the 'GC1234' ones that are optimized for receivers of the lowest + common denominator. + A geocacher using Linux with a Magellan receiver may thus find commands like this useful. gpsbabel -s -i geo -f geocaching.loc -o magellan -F /dev/ttyS0 + His counterpart on Windows will find this equivalent gpsbabel -s -i geo -f geocaching.loc -o magellan -F com1 diff --git a/xmldoc/formats/csv.xml b/xmldoc/formats/csv.xml index 3b2e1112c..feb3caf9e 100644 --- a/xmldoc/formats/csv.xml +++ b/xmldoc/formats/csv.xml @@ -1,8 +1,7 @@ - There are a billion variants of Comma Separated Value -data. This is the one that makes Delorme S&A Deluxe 9 happy. It's +data. This is the one specifically that makes Delorme S&A Deluxe 9 happy. It's also a very simple program and useful for many other programs like spreadsheets. CSV is also the correct format for @@ -18,3 +17,11 @@ on read it will read anything supported by our universal csv format. +Example 'csv' file + +35.97203, -87.13470, Mountain Bike Heaven by susy1313 +36.09068, -86.67955, The Troll by a182pilot & Family +35.99627, -86.62012, Dive Bomber by JoGPS & family +36.03848, -86.64862, FOSTER by JoGPS & Family + + diff --git a/xmldoc/formats/dg-100.xml b/xmldoc/formats/dg-100.xml index 1434c6617..35b95bb62 100644 --- a/xmldoc/formats/dg-100.xml +++ b/xmldoc/formats/dg-100.xml @@ -7,3 +7,13 @@ Command showing DG-100 download and erase on Linux gpsbabel -t -i dg-100,erase -o gpx /dev/ttyUSB0 outputfile.gpx + + +The DG-100 provides a physical USB interface to the host computer, but +internally it uses a Prolific PL-2303 chip to do this. So you must have +drivers installed on your computer to recognize the PL-2303 and provide +that data as a serial port to software like GPSBabel. Such software +comes with the unit for Windows. Prolific provides software for Mac OS/X, +but unfortunately their driver has a defect which makes it unusable with +GPSBabel. + diff --git a/xmldoc/formats/gpx.xml b/xmldoc/formats/gpx.xml index 9f68c0ae2..d70cb77af 100644 --- a/xmldoc/formats/gpx.xml +++ b/xmldoc/formats/gpx.xml @@ -9,6 +9,6 @@ supported by EasyGPS, ExpertGPS, and many other programs described at GPSBabel's reader of this module attempts to preserve tags it doesn't really understand. It also tries to glean interesting data from - pocket queries from Geocaching.com. + pocket queries from Geocaching.com and Garmin's "gpxx" GPX extensions. diff --git a/xmldoc/formats/kml.xml b/xmldoc/formats/kml.xml index b35632ba0..1e350a721 100644 --- a/xmldoc/formats/kml.xml +++ b/xmldoc/formats/kml.xml @@ -1,10 +1,13 @@ KML, the Keyhole Markup Language, is used by Keyhole and -Google Earth. There are features in this file format that GPSBabel -doesn't support - such as camera views - but waypoints, tracks, and routes -work well. +Google Earth. There are numerous +features in this file format that GPSBabel +doesn't support - such as camera views - but core spport waypoints, tracks, and routes work well. Google Earth also uses GPSBabel internally for receiver communications and several file format imports and exports. + +In general, GPSBabel's KML writer is relatively strong. GPSBabel handles simple KML on read fairly well, but if you're dealing with handcrafted KML that uses extensive features that have no analog in other formats like nested folders, ringgeometry, camera angles, and such, don't expect GPSBabel to do well with them on read. + diff --git a/xmldoc/formats/options/garmin-resettime.xml b/xmldoc/formats/options/garmin-resettime.xml new file mode 100644 index 000000000..8b1378917 --- /dev/null +++ b/xmldoc/formats/options/garmin-resettime.xml @@ -0,0 +1 @@ + diff --git a/xmldoc/formats/options/garmin_gpi-alerts.xml b/xmldoc/formats/options/garmin_gpi-alerts.xml new file mode 100644 index 000000000..8b1378917 --- /dev/null +++ b/xmldoc/formats/options/garmin_gpi-alerts.xml @@ -0,0 +1 @@ + diff --git a/xmldoc/formats/options/garmin_gpi-unique.xml b/xmldoc/formats/options/garmin_gpi-unique.xml new file mode 100644 index 000000000..8b1378917 --- /dev/null +++ b/xmldoc/formats/options/garmin_gpi-unique.xml @@ -0,0 +1 @@ + diff --git a/xmldoc/formats/options/garmin_gpi-units.xml b/xmldoc/formats/options/garmin_gpi-units.xml new file mode 100644 index 000000000..8b1378917 --- /dev/null +++ b/xmldoc/formats/options/garmin_gpi-units.xml @@ -0,0 +1 @@ + diff --git a/xmldoc/formats/options/ozi-proximity.xml b/xmldoc/formats/options/ozi-proximity.xml new file mode 100644 index 000000000..8b1378917 --- /dev/null +++ b/xmldoc/formats/options/ozi-proximity.xml @@ -0,0 +1 @@ + -- 2.30.2